Class RecurringDonation

Namespace

Crews.PlanningCenter.Api.Giving.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Attributes for the RecurringDonation resource.

public record RecurringDonation : IEquatable<RecurringDonation>

Inheritance

object

RecurringDonation

Implements

IEquatable<RecurringDonation>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

RecurringDonation()

public RecurringDonation()

RecurringDonation(RecurringDonation)

protected RecurringDonation(RecurringDonation original)

Parameters

original RecurringDonation

Properties

AmountCents

The number of cents scheduled to be donated.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("amount_cents")]
public int? AmountCents { get; init; }

Property Value

int?

AmountCurrency

The currency of amount_cents.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("amount_currency")]
public string? AmountCurrency { get; init; }

Property Value

string

CreatedAt

The date and time at which a recurring donation was created. Example: 2000-01-01T12:00:00Z

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("created_at")]
public DateTime? CreatedAt { get; init; }

Property Value

DateTime?

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type

LastDonationReceivedAt

The date and time that the last donation was made for a recurring donation. Example: 2000-01-01T12:00:00Z

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("last_donation_received_at")]
public DateTime? LastDonationReceivedAt { get; init; }

Property Value

DateTime?

NextOccurrence

The date that the next donation will be made for a recurring donation. Example: 2000-01-01T12:00:00Z

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("next_occurrence")]
public DateTime? NextOccurrence { get; init; }

Property Value

DateTime?

ReleaseHoldAt

The date when the hold on a recurring donation with a status of temporary_hold will be released.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("release_hold_at")]
public DateTime? ReleaseHoldAt { get; init; }

Property Value

DateTime?

Schedule

JSON representation of the billing schedule. See the repeatable Ruby gem for more details on the structure and meaning: https://github.com/molawson/repeatable#time-expressions

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("schedule")]
public JsonObject? Schedule { get; init; }

Property Value

JsonObject

Status

Determines if a recurring donation is active or on hold, and if on hold, the kind of hold that has been placed on it.

Possible values: active, indefinite_hold or temporary_hold.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("status")]
public string? Status { get; init; }

Property Value

string

UpdatedAt

The date and time at which a recurring donation was last updated. Example: 2000-01-01T12:00:00Z

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("updated_at")]
public DateTime? UpdatedAt { get; init; }

Property Value

DateTime?

Methods

Equals(RecurringDonation?)

public virtual bool Equals(RecurringDonation? other)

Parameters

other RecurringDonation

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

PrintMembers(StringBuilder)

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

ToString()

public override string ToString()

Returns

string

Operators

operator ==(RecurringDonation?, RecurringDonation?)

public static bool operator ==(RecurringDonation? left, RecurringDonation? right)

Parameters

left RecurringDonation

right RecurringDonation

Returns

bool

operator !=(RecurringDonation?, RecurringDonation?)

public static bool operator !=(RecurringDonation? left, RecurringDonation? right)

Parameters

left RecurringDonation

right RecurringDonation

Returns

bool